
<!DOCTYPE html>

<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>UnicornFy &#8212; unicorn-fy 0.9.0 documentation</title>
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="_static/pydoctheme.css" type="text/css" />
    
    <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script src="_static/jquery.js"></script>
    <script src="_static/underscore.js"></script>
    <script src="_static/doctools.js"></script>
    
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="copyright" title="Copyright" href="copyright.html" />
    <link rel="next" title="unicorn_fy" href="modules.html" />
    <link rel="prev" title="Welcome to UnicornFy’s documentation!" href="index.html" />
    <link rel="shortcut icon" type="image/png" href="_static/py.png" />
    <script async defer src="https://buttons.github.io/buttons.js"></script>
    
    <script type="text/javascript" src="_static/copybutton.js"></script>
    
     

  </head><body>  
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="modules.html" title="unicorn_fy"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="index.html" title="Welcome to UnicornFy’s documentation!"
             accesskey="P">previous</a> |</li>
    
    <li><img src="_static/github-logo.png" alt=""
             style="vertical-align: middle; margin-top: -1px"/></li>
    <li><a href="https://github.com/oliver-zehentleitner/unicorn-fy">unicorn-fy</a> &#187;</li>
    
    
    <a href="index.html">unicorn-fy 0.9.0 documentation</a> &#187;
    

        <li class="nav-item nav-item-this"><a href="">UnicornFy</a></li>
    <li class="right">
        <a href="search.html" title="Search">search</a>
         |
    </li>

      </ul>
    </div>    

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <p><a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy/releases/latest"><img alt="GitHub release" src="https://img.shields.io/github/release/oliver-zehentleitner/unicorn-fy.svg" /></a>
<a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy/blob/master/LICENSE"><img alt="GitHub" src="https://img.shields.io/github/license/oliver-zehentleitner/unicorn-fy.svg?color=blue" /></a>
<a class="reference external" href="https://www.python.org/downloads/"><img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/unicorn_fy.svg" /></a>
<a class="reference external" href="https://pepy.tech/project/unicorn-fy"><img alt="Downloads" src="https://pepy.tech/badge/unicorn-fy" /></a>
<a class="reference external" href="https://pypi.org/project/unicorn-fy/"><img alt="PyPI - Wheel" src="https://img.shields.io/pypi/wheel/unicorn_fy.svg?label=PyPI%20wheel" /></a>
<a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy/issues"><img alt="PyPI - Status" src="https://img.shields.io/pypi/status/unicorn_fy.svg" /></a>
<a class="reference external" href="https://travis-ci.com/oliver-zehentleitner/unicorn-fy"><img alt="Build Status" src="https://travis-ci.com/oliver-zehentleitner/unicorn-fy.svg?branch=master" /></a>
<a class="reference external" href="https://lgtm.com/projects/g/oliver-zehentleitner/unicorn-fy/alerts/"><img alt="Total alerts" src="https://img.shields.io/lgtm/alerts/g/oliver-zehentleitner/unicorn-fy.svg?logo=lgtm&amp;logoWidth=18" /></a>
<a class="reference external" href="https://lgtm.com/projects/g/oliver-zehentleitner/unicorn-fy/context:python"><img alt="Language grade: Python" src="https://img.shields.io/lgtm/grade/python/g/oliver-zehentleitner/unicorn-fy.svg?logo=lgtm&amp;logoWidth=18" /></a>
<a class="reference external" href="https://coveralls.io/github/oliver-zehentleitner/unicorn-fy?branch=master"><img alt="Coverage Status" src="https://coveralls.io/repos/github/oliver-zehentleitner/unicorn-fy/badge.svg?branch=master" /></a>
<a class="reference external" href="https://t.me/unicorndevs"><img alt="Telegram" src="https://img.shields.io/badge/chat-telegram-yellow.svg" /></a>
<a class="reference external" href="https://liberapay.com/oliver-zehentleitner/donate"><img alt="Donations/week" src="http://img.shields.io/liberapay/receives/oliver-zehentleitner.svg?logo=liberapay" /></a>
<a class="reference external" href="https://liberapay.com/oliver-zehentleitner/donate"><img alt="Patrons" src="http://img.shields.io/liberapay/patrons/oliver-zehentleitner.svg?logo=liberapay%22" /></a></p>
<div class="section" id="unicornfy">
<h1>UnicornFy<a class="headerlink" href="#unicornfy" title="Permalink to this headline">¶</a></h1>
<p><a class="reference external" href="#supported-exchanges">Supported Exchanges</a> | <a class="reference external" href="#installation-and-upgrade">Installation</a> | <a class="reference external" href="#documentation">Documentation</a> |
<a class="reference external" href="#change-log">Change Log</a> | <a class="reference external" href="#wiki">Wiki</a> | <a class="reference external" href="#social">Social</a> | <a class="reference external" href="#receive-notifications">Notifications</a> |
<a class="reference external" href="#how-to-report-bugs-or-suggest-improvements">Bugs</a> | <a class="reference external" href="#contributing">Contributing</a> | <a class="reference external" href="#commercial-support">Commercial Support</a> | <a class="reference external" href="#donate">Donate</a></p>
<p>Convert received raw data from crypto exchange API endpoints into well-formed python dictionaries.</p>
<p><a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy">UnicornFy</a> is a side project of
<a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api">UNICORN Binance WebSocket API</a> but can be used
with every API that delivers the receives in raw format (as received without changes).</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">unicorn_fy.unicorn_fy</span> <span class="kn">import</span> <span class="n">UnicornFy</span>

<span class="n">received_stream_data_json</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;stream&quot;</span><span class="p">:</span> <span class="s2">&quot;btcusdt@trade&quot;</span><span class="p">,</span>
                             <span class="s2">&quot;data&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;e&quot;</span><span class="p">:</span> <span class="s2">&quot;trade&quot;</span><span class="p">,</span>
                                      <span class="s2">&quot;E&quot;</span><span class="p">:</span> <span class="mi">1556876873656</span><span class="p">,</span>
                                      <span class="s2">&quot;s&quot;</span><span class="p">:</span> <span class="s2">&quot;BTCUSDT&quot;</span><span class="p">,</span>
                                      <span class="s2">&quot;t&quot;</span><span class="p">:</span> <span class="mi">117727701</span><span class="p">,</span>
                                      <span class="s2">&quot;p&quot;</span><span class="p">:</span> <span class="s2">&quot;5786.76000000&quot;</span><span class="p">,</span>
                                      <span class="s2">&quot;q&quot;</span><span class="p">:</span> <span class="s2">&quot;0.03200500&quot;</span><span class="p">,</span>
                                      <span class="s2">&quot;b&quot;</span><span class="p">:</span> <span class="mi">341831847</span><span class="p">,</span>
                                      <span class="s2">&quot;a&quot;</span><span class="p">:</span> <span class="mi">341831876</span><span class="p">,</span>
                                      <span class="s2">&quot;T&quot;</span><span class="p">:</span> <span class="mi">1556876873648</span><span class="p">,</span>
                                      <span class="s2">&quot;m&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
                                      <span class="s2">&quot;M&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">}}</span>

<span class="n">unicorn_fied_stream_data</span> <span class="o">=</span> <span class="n">UnicornFy</span><span class="o">.</span><span class="n">binance_com_websocket</span><span class="p">(</span><span class="n">received_stream_data_json</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="n">unicorn_fied_stream_data</span><span class="p">)</span>
<span class="o">&gt;&gt;&gt;</span>
<span class="p">{</span><span class="s1">&#39;stream_type&#39;</span><span class="p">:</span> <span class="s1">&#39;btcusdt@trade&#39;</span><span class="p">,</span> <span class="s1">&#39;event_type&#39;</span><span class="p">:</span> <span class="s1">&#39;trade&#39;</span><span class="p">,</span> <span class="s1">&#39;event_time&#39;</span><span class="p">:</span> <span class="mi">1556876873656</span><span class="p">,</span> <span class="s1">&#39;symbol&#39;</span><span class="p">:</span> <span class="s1">&#39;BTCUSDT&#39;</span><span class="p">,</span> <span class="s1">&#39;trade_id&#39;</span><span class="p">:</span> <span class="mi">117727701</span><span class="p">,</span> <span class="s1">&#39;price&#39;</span><span class="p">:</span> <span class="s1">&#39;5786.76000000&#39;</span><span class="p">,</span> <span class="s1">&#39;quantity&#39;</span><span class="p">:</span> <span class="s1">&#39;0.03200500&#39;</span><span class="p">,</span> <span class="s1">&#39;buyer_order_id&#39;</span><span class="p">:</span> <span class="mi">341831847</span><span class="p">,</span> <span class="s1">&#39;seller_order_id&#39;</span><span class="p">:</span> <span class="mi">341831876</span><span class="p">,</span> <span class="s1">&#39;trade_time&#39;</span><span class="p">:</span> <span class="mi">1556876873648</span><span class="p">,</span> <span class="s1">&#39;is_market_maker&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="s1">&#39;ignore&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="s1">&#39;unicorn_fied&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;binance&#39;</span><span class="p">,</span> <span class="s1">&#39;0.1.0&#39;</span><span class="p">]}</span>
</pre></div>
</div>
<div class="section" id="supported-exchanges">
<h2>Supported Exchanges<a class="headerlink" href="#supported-exchanges" title="Permalink to this headline">¶</a></h2>
<div class="section" id="websockets">
<h3>Websockets<a class="headerlink" href="#websockets" title="Permalink to this headline">¶</a></h3>
<table border="1" class="docutils">
<thead>
<tr>
<th>Exchange</th>
<th>Docs</th>
<th>Status</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="https://www.binance.com">Binance</a> (<a href="https://github.com/binance-exchange/binance-official-api-docs">API</a>)</td>
<td><a href="https://oliver-zehentleitner.github.io/unicorn-fy/unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_websocket"><code>binance_com_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://testnet.binance.vision/">Binance Testnet</a> (<a href="https://github.com/binance-exchange/binance-official-api-docs">API</a>)</td>
<td><a href="https://oliver-zehentleitner.github.io/unicorn-fy/unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_websocket"><code>binance_com_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://www.binance.com">Binance Margin</a> (<a href="https://github.com/binance-exchange/binance-official-api-docs">API</a>)</td>
<td><a href="https://oliver-zehentleitner.github.io/unicorn-fy/unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_margin_websocket"><code>binance_com_margin_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://testnet.binance.vision/">Binance Margin Testnet</a> (<a href="https://github.com/binance-exchange/binance-official-api-docs">API</a>)</td>
<td><a href="https://oliver-zehentleitner.github.io/unicorn-fy/unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_margin_websocket"><code>binance_com_margin_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://www.binance.com">Binance Isolated Margin</a> (<a href="https://github.com/binance-exchange/binance-official-api-docs">API</a>)</td>
<td><a href="https://oliver-zehentleitner.github.io/unicorn-fy/unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_isolated_margin_websocket"><code>binance_com_isolated_margin_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://testnet.binance.vision/">Binance Isolated Margin Testnet</a> (<a href="https://github.com/binance-exchange/binance-official-api-docs">API</a>)</td>
<td><a href="https://oliver-zehentleitner.github.io/unicorn-fy/unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_isolated_margin_websocket"><code>binance_com_isolated_margin_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://www.binance.com">Binance Futures</a> (<a href="https://github.com/binance-exchange/binance-official-api-docs">API</a>)</td>
<td><a href="https://oliver-zehentleitner.github.io/unicorn-fy/unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_futures_websocket"><code>binance_com_futures_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://testnet.binancefuture.com">Binance Futures Testnet</a> (<a href="https://github.com/binance-exchange/binance-official-api-docs">API</a>)</td>
<td><a href="https://oliver-zehentleitner.github.io/unicorn-fy/unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_futures_websocket"><code>binance_com_futures_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://www.binance.je">Binance Jersey</a> (<a href="https://github.com/binance-jersey/binance-official-api-docs/">API</a>)</td>
<td><a href="https://oliver-zehentleitner.github.io/unicorn-fy/unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_je_websocket"><code>binance_je_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://www.binance.us">Binance US</a> (<a href="https://github.com/binance-us/binance-official-api-docs">API</a>)</td>
<td><a href="https://oliver-zehentleitner.github.io/unicorn-fy/unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_us_websocket"><code>binance_us_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://www.trbinance.com">Binance TR</a> (<a href="https://www.trbinance.com/apidocs">API</a>)</td>
<td><a href="https://oliver-zehentleitner.github.io/unicorn-fy/unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.trbinance_com_websocket"><code>trbinance_com_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://www.jex.com">Binance JEX</a> (<a href="https://jexapi.github.io/api-doc/spot.html#change-log">API</a>)</td>
<td><a href="https://oliver-zehentleitner.github.io/unicorn-fy/unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.jex_com_websocket"><code>jex_com_websocket(stream_data_json)</code></a></td>
<td>STABLE</td>
</tr>
<tr>
<td><a href="https://www.binance.org">Binance DEX</a> (<a href="https://docs.binance.org/">API</a>)</td>
<td><a href="https://oliver-zehentleitner.github.io/unicorn-fy/unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_org_websocket"><code>binance_org_websocket(stream_data_json)</code></a></td>
<td>NEEDS_YOUR_HELP</td>
</tr>
<tr>
<td><a href="https://testnet.binance.org">Binance DEX Testnet</a> (<a href="https://docs.binance.org/">API</a>)</td>
<td><a href="https://oliver-zehentleitner.github.io/unicorn-fy/unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_org_websocket"><code>binance_org_websocket(stream_data_json)</code></a></td>
<td>NEEDS_YOUR_HELP</td>
</tr>
</tbody>
</table></div>
<div class="section" id="rest">
<h3>REST<a class="headerlink" href="#rest" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><p>none</p></li>
</ul>
<p>If you like the project, please
<a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy/stargazers"><img alt="star" src="https://raw.githubusercontent.com/oliver-zehentleitner/unicorn-fy/master/images/misc/star.png" /></a> it on
<a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy">GitHub</a>!</p>
</div>
</div>
<div class="section" id="installation-and-upgrade">
<h2>Installation and Upgrade<a class="headerlink" href="#installation-and-upgrade" title="Permalink to this headline">¶</a></h2>
<p>The module requires Python 3.6.0 or above.</p>
<p>The current dependencies are listed
<a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy/blob/master/requirements.txt">here</a>.</p>
<div class="section" id="a-wheel-of-the-latest-release-with-pip-from-pypi">
<h3>A wheel of the latest release with PIP from <a class="reference external" href="https://pypi.org/project/unicorn-fy/">PyPI</a><a class="headerlink" href="#a-wheel-of-the-latest-release-with-pip-from-pypi" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">unicorn-fy</span> <span class="pre">--upgrade</span></code></p>
</div>
<div class="section" id="from-source-of-the-latest-release-with-pip-from-github">
<h3>From source of the latest release with PIP from <a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy">Github</a><a class="headerlink" href="#from-source-of-the-latest-release-with-pip-from-github" title="Permalink to this headline">¶</a></h3>
<div class="section" id="linux-macos">
<h4>Linux, macOS, …<a class="headerlink" href="#linux-macos" title="Permalink to this headline">¶</a></h4>
<p>Run in bash:</p>
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">https://github.com/oliver-zehentleitner/unicorn-fy/archive/$(curl</span> <span class="pre">-s</span> <span class="pre">https://api.github.com/repos/oliver-zehentleitner/unicorn-fy/releases/latest</span> <span class="pre">|</span> <span class="pre">grep</span> <span class="pre">-oP</span> <span class="pre">'&quot;tag_name&quot;:</span> <span class="pre">&quot;\K(.*)(?=&quot;)').tar.gz</span> <span class="pre">--upgrade</span></code></p>
</div>
<div class="section" id="windows">
<h4>Windows<a class="headerlink" href="#windows" title="Permalink to this headline">¶</a></h4>
<p>Use the below command with the version (such as 0.7.0) you determined <a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy/releases/latest">here</a>:</p>
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">https://github.com/oliver-zehentleitner/unicorn-fy/archive/0.7.0.tar.gz</span> <span class="pre">--upgrade</span></code></p>
</div>
</div>
<div class="section" id="from-the-latest-source-dev-stage-with-pip-from-github">
<h3>From the latest source (dev-stage) with PIP from <a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy">Github</a><a class="headerlink" href="#from-the-latest-source-dev-stage-with-pip-from-github" title="Permalink to this headline">¶</a></h3>
<p>This is not a release version and can not be considered to be stable!</p>
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">https://github.com/oliver-zehentleitner/unicorn-fy/tarball/master</span> <span class="pre">--upgrade</span></code></p>
</div>
<div class="section" id="conda-environment-virtualenv-or-plain-python">
<h3><a class="reference external" href="https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html">Conda environment</a>, <a class="reference external" href="https://virtualenv.pypa.io/en/latest/">Virtualenv</a> or plain <a class="reference external" href="https://docs.python.org/2/install/">Python</a><a class="headerlink" href="#conda-environment-virtualenv-or-plain-python" title="Permalink to this headline">¶</a></h3>
<p>Download the <a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy/releases/latest">latest release</a>
or the <a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy/archive/master.zip">current master branch</a>
and use:</p>
<ul class="simple">
<li><p>./environment.yml</p></li>
<li><p>./requirements.txt</p></li>
<li><p>./setup.py</p></li>
</ul>
</div>
</div>
<div class="section" id="documentation">
<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://oliver-zehentleitner.github.io/unicorn-fy">General</a></p></li>
<li><p><a class="reference external" href="https://oliver-zehentleitner.github.io/unicorn-fy/unicorn_fy.html">Modules</a></p></li>
</ul>
</div>
<div class="section" id="source-downloads-examples">
<h2>Source, Downloads, Examples, …<a class="headerlink" href="#source-downloads-examples" title="Permalink to this headline">¶</a></h2>
<p><a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy">https://github.com/oliver-zehentleitner/unicorn-fy</a></p>
</div>
<div class="section" id="change-log">
<h2>Change Log<a class="headerlink" href="#change-log" title="Permalink to this headline">¶</a></h2>
<p><a class="reference external" href="https://oliver-zehentleitner.github.io/unicorn-fy/CHANGELOG.html">https://oliver-zehentleitner.github.io/unicorn-fy/CHANGELOG.html</a></p>
</div>
<div class="section" id="wiki">
<h2>Wiki<a class="headerlink" href="#wiki" title="Permalink to this headline">¶</a></h2>
<p><a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy/wiki">https://github.com/oliver-zehentleitner/unicorn-fy/wiki</a></p>
</div>
<div class="section" id="social">
<h2>Social<a class="headerlink" href="#social" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://t.me/unicorndevs">https://t.me/unicorndevs</a></p></li>
<li><p><a class="reference external" href="https://dev.binance.vision">https://dev.binance.vision</a></p></li>
<li><p><a class="reference external" href="https://community.binance.org">https://community.binance.org</a></p></li>
</ul>
</div>
<div class="section" id="receive-notifications">
<h2>Receive Notifications<a class="headerlink" href="#receive-notifications" title="Permalink to this headline">¶</a></h2>
<p>To receive notifications on available updates you can
<a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy/watchers"><img alt="watch" src="https://raw.githubusercontent.com/oliver-zehentleitner/unicorn-fy/master/images/misc/watch.png" /></a>
the repository on <a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy">GitHub</a>, write your
<a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy/blob/master/example_version_of_this_package.py">own script</a>
with using
<a class="reference external" href="https://oliver-zehentleitner.github.io/unicorn-fy/unicorn_fy.html?highlight=is_update#unicorn_fy.unicorn_fy.UnicornFy.is_update_availabe"><code class="docutils literal notranslate"><span class="pre">is_update_availabe()</span></code></a>
or you use the
<a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/wiki/UNICORN-Monitoring-API-Service">monitoring API service</a>.</p>
</div>
<div class="section" id="how-to-report-bugs-or-suggest-improvements">
<h2>How to report Bugs or suggest Improvements?<a class="headerlink" href="#how-to-report-bugs-or-suggest-improvements" title="Permalink to this headline">¶</a></h2>
<p><a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement">List of planned features</a> -
click <img alt="thumbs-up" src="https://raw.githubusercontent.com/oliver-zehentleitner/unicorn-fy/master/images/misc/thumbup.png" /> if you need one of them or suggest a new feature!</p>
<p>Before you report a bug, <a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy#installation-and-upgrade">try the latest release</a>.
If the issue still exists, provide the error trace, OS and python version and explain how to reproduce the error.
A demo script is appreciated.</p>
<p>If you dont find an issue related to your topic, please open a new issue:
<a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy/issues">https://github.com/oliver-zehentleitner/unicorn-fy/issues</a></p>
<p><a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy/security/policy">Report a security bug!</a></p>
</div>
<div class="section" id="contributing">
<h2>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h2>
<p><a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy">unicorn-fy</a>  is an open
source project which welcomes contributions which can be anything from simple documentation fixes and reporting dead links to new features. To
contribute follow
<a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy/blob/master/CONTRIBUTING.md">this guide</a>.</p>
<div class="section" id="contributors">
<h3>Contributors<a class="headerlink" href="#contributors" title="Permalink to this headline">¶</a></h3>
<p><a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy/graphs/contributors"><img alt="Contributors" src="https://contributors-img.web.app/image?repo=oliver-zehentleitner/unicorn-fy" /></a></p>
<p>We <img alt="love" src="https://raw.githubusercontent.com/oliver-zehentleitner/unicorn-fy/master/images/misc/heart.png" /> open source!</p>
</div>
</div>
<div class="section" id="commercial-support">
<h2>Commercial Support<a class="headerlink" href="#commercial-support" title="Permalink to this headline">¶</a></h2>
<p>Need a Python developer or consulting?</p>
<p>Contact <a class="reference external" href="https://about.me/oliver-zehentleitner">me</a> for a non-binding and free consultation via my company
<a class="reference external" href="https://www.lucit.dev">LUCIT</a> from Vienna (Austria).</p>
<div class="section" id="donate">
<h3>Donate<a class="headerlink" href="#donate" title="Permalink to this headline">¶</a></h3>
<p>Since you are probably a developer yourself, you will understand very well that the creation of open source software is
not free - it requires technical knowledge, a lot of time and also financial expenditure.</p>
<p>If you would like to help me to dedicate my time and energy to this project, even small donations are very welcome.</p>
<p><a class="reference external" href="https://liberapay.com/oliver-zehentleitner/donate"><img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg" /></a></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">BTC</span><span class="p">:</span> <span class="mi">39</span><span class="n">fS74fvcGnmEk8JUV8bG6P1wkdH29GtsA</span>
<span class="n">LUNA</span><span class="p">:</span> <span class="n">terra1ncjg4a59x2pgvqy9qjyqprlj8lrwshm0wleht5</span> <span class="p">(</span><span class="n">Memo</span><span class="p">:</span> <span class="mi">108157985</span><span class="p">)</span>
<span class="n">DASH</span><span class="p">:</span> <span class="n">XsRhBuPkXGF9WvifdpkVhTGSmVT4VcuQZ7</span>
<span class="n">ETH</span><span class="p">:</span> <span class="mh">0x1C15857Bf1E18D122dDd1E536705748aa529fc9C</span>
<span class="n">LTC</span><span class="p">:</span> <span class="n">LYNzHMFUbee3siyHvNCPaCjqXxjyq8YRGJ</span>
<span class="n">XMR</span><span class="p">:</span> <span class="mi">85</span><span class="n">dzsTRh6GRPGVSJoUbFDwAf9uwwAdim1HFpiGshLeKHgj2hVqKtYVPXMZvudioLsuLS1AegkUiQ12jwReRwWcFvF7kDAbF</span>
<span class="n">ZEC</span><span class="p">:</span> <span class="n">t1WvQMPJMriGWD9qkZGDdE9tTJaawvmsBie</span>
</pre></div>
</div>
</div>
</div>
</div>


            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">UnicornFy</a><ul>
<li><a class="reference internal" href="#supported-exchanges">Supported Exchanges</a><ul>
<li><a class="reference internal" href="#websockets">Websockets</a></li>
<li><a class="reference internal" href="#rest">REST</a></li>
</ul>
</li>
<li><a class="reference internal" href="#installation-and-upgrade">Installation and Upgrade</a><ul>
<li><a class="reference internal" href="#a-wheel-of-the-latest-release-with-pip-from-pypi">A wheel of the latest release with PIP from PyPI</a></li>
<li><a class="reference internal" href="#from-source-of-the-latest-release-with-pip-from-github">From source of the latest release with PIP from Github</a><ul>
<li><a class="reference internal" href="#linux-macos">Linux, macOS, …</a></li>
<li><a class="reference internal" href="#windows">Windows</a></li>
</ul>
</li>
<li><a class="reference internal" href="#from-the-latest-source-dev-stage-with-pip-from-github">From the latest source (dev-stage) with PIP from Github</a></li>
<li><a class="reference internal" href="#conda-environment-virtualenv-or-plain-python">Conda environment, Virtualenv or plain Python</a></li>
</ul>
</li>
<li><a class="reference internal" href="#documentation">Documentation</a></li>
<li><a class="reference internal" href="#source-downloads-examples">Source, Downloads, Examples, …</a></li>
<li><a class="reference internal" href="#change-log">Change Log</a></li>
<li><a class="reference internal" href="#wiki">Wiki</a></li>
<li><a class="reference internal" href="#social">Social</a></li>
<li><a class="reference internal" href="#receive-notifications">Receive Notifications</a></li>
<li><a class="reference internal" href="#how-to-report-bugs-or-suggest-improvements">How to report Bugs or suggest Improvements?</a></li>
<li><a class="reference internal" href="#contributing">Contributing</a><ul>
<li><a class="reference internal" href="#contributors">Contributors</a></li>
</ul>
</li>
<li><a class="reference internal" href="#commercial-support">Commercial Support</a><ul>
<li><a class="reference internal" href="#donate">Donate</a></li>
</ul>
</li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="index.html"
                        title="previous chapter">Welcome to UnicornFy’s documentation!</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="modules.html"
                        title="next chapter">unicorn_fy</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/README.md.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<br />
    
<a class="github-button" href="https://github.com/oliver-zehentleitner/unicorn-fy"
   data-icon="octicon-star" data-show-count="true"
   aria-label="Star oliver-zehentleitner/unicorn-fy on GitHub">Star</a>
<br />
<a class="github-button" href="https://github.com/oliver-zehentleitner/unicorn-fy/subscription"
   data-icon="octicon-eye" data-show-count="true"
   aria-label="Watch oliver-zehentleitner/unicorn-fy on GitHub">Watch</a>
<br />
<a class="github-button" href="https://github.com/oliver-zehentleitner/unicorn-fy/fork"
   data-icon="octicon-repo-forked" data-show-count="true"
   aria-label="Fork oliver-zehentleitner/unicorn-fy on GitHub">Fork</a>
<br />
<a class="github-button" href="https://github.com/oliver-zehentleitner/unicorn-fy/issues"
   data-icon="octicon-issue-opened"
   data-show-count="true" aria-label="Issue oliver-zehentleitner/unicorn-fy on GitHub">Issue</a>
    

        </div>
      </div>
      <div class="clearer"></div>
    </div>  
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="modules.html" title="unicorn_fy"
             >next</a> |</li>
        <li class="right" >
          <a href="index.html" title="Welcome to UnicornFy’s documentation!"
             >previous</a> |</li>
    
    <li><img src="_static/github-logo.png" alt=""
             style="vertical-align: middle; margin-top: -1px"/></li>
    <li><a href="https://github.com/oliver-zehentleitner/unicorn-fy">unicorn-fy</a> &#187;</li>
    
    
    <a href="index.html">unicorn-fy 0.9.0 documentation</a> &#187;
    

        <li class="nav-item nav-item-this"><a href="">UnicornFy</a></li>
    <li class="right">
        <a href="search.html" title="Search">search</a>
         |
    </li>

      </ul>
    </div>  
    <div class="footer">
    &copy; <a href="copyright.html">Copyright</a> 2021, Oliver Zehentleitner.
    <br />

    Last updated on Mar 18 2021 at 21:43 (CET).
    <a href="https://github.com/oliver-zehentleitner/unicorn-fy/issues">Found a bug</a>?
    <br />

    <img src="_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px" />
    The <a href="https://www.python.org">Python</a> Software Foundation is a non-profit corporation.
    <a href="https://www.python.org/psf/donations/">Please donate.</a>
    <br />

    Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 3.5.2
        with <a href="https://github.com/oliver-zehentleitner/python-docs-theme-technopathy">python-docs-theme-technopathy</a>
        by <a href="https://about.me/oliver-zehentleitner">Oliver Zehentleitner</a>.
    <br />
        <a href="https://www.technopathy.club/2019/11/03/use-python-sphinx-on-github-pages-with-html-and-an-indivdual-theme">
    Create a GitHub Page like this one!</a>    <br />
        Powered by <a href="https://www.lucit.co/desktop-and-server-apps.html">LUCIT - Python Development</a>
    </div>

  </body>
</html>